Skip to main content

MongoDB Atlas Cost Exports with nOps Platform

To integrate MongoDB Atlas with nOps BC+, follow these steps:

  1. Find Your Organization ID in MongoDB Atlas
  2. Create API Keys with Required Permissions in MongoDB Atlas
  3. Configure Project Access in MongoDB Atlas
  4. Set Up Integration in nOps Platform

Prerequisites

Before setting up the integration, ensure you have:

  1. MongoDB Atlas Account

    • Active MongoDB Atlas account
    • Organization Administrator access
  2. Required Permissions

    • Ability to create API keys
    • Permission to manage project access
    • If using IP restrictions:
      • This feature is coming soon!
  3. Required Information

    • MongoDB Atlas Organization ID
    • API keys with billing view permission
    • List of projects to monitor

How the Integration Works

  1. API Key Creation

    • Create API keys in MongoDB Atlas with billing view permission
    • Configure IP Access List if required
    • Invite the API keys to each project you want to monitor
  2. Integration Setup

    • Enter your MongoDB Atlas Organization ID
    • Configure the public and private API keys in nOps
    note

    Make sure to keep your API keys secure and never share them with unauthorized users. If you Need IP Access List use 52.11.169.55

  3. Data Retrieval by nOps

    • nOps uses the provided credentials to fetch billing data from MongoDB Atlas
    • Data is collected for all projects where the API keys have been granted access
  4. Data Processing

    • The retrieved data is processed and displayed within the Business Context+ product
    • Cost information is organized by project and resource type

Step 1: Find Your Organization ID

The Organization ID is a unique 24-character hexadecimal identifier required for the integration. It allows nOps to identify and fetch data from your MongoDB Atlas organization.

  1. Access Organization Settings

  2. Locate Organization ID

    • Find the field labeled "Organization ID"
    • Copy the 24-character ID exactly as shown
tip
  • The ID is located in Organization Settings, not Project Settings
  • Ensure you're in the correct organization if you have access to multiple
Click to view a screenshot of the MongoDB Atlas Organization Settings page

MongoDB Atlas Organization Settings page

Multiple Organizations

To monitor multiple organizations in nOps:

  • You need the unique Organization ID for each
  • Create separate API keys with appropriate permissions
  • Configure project access for each
  • Set up separate integrations in nOps

Step 2: Create API Keys with Required Permissions

API keys are required for secure access to your MongoDB Atlas data.

  1. Access API Key Settings

    • In Organization Settings, click on Access Manager
    • Select the Applications tab
    • Click Add new
    • Select API Key
  2. Set API Key Permissions

    • Enter a name (e.g., "nOps Integration")
    • Assign the Organization Billing Viewer role
    important

    If your organization requires the usage of IP Access List for the Atlas Administration API, Add this IP: 52.11.169.55

  3. Save API Credentials

    • Copy the Public Key and Private Key
    • Store them securely—private keys are shown only once
caution

Do not share your keys or expose them in public repositories. If the private key is lost, you'll need to regenerate the keys.

Click to view a screenshot of the API Key creation interface

API Key creation


Step 3: Configure Project Access

To get Project level data, follow these steps:

  1. Access your Projects
    • In Organization Settings, click Projects
    • Select one project in the list
    • Click on Access Manager on the top and select Project Access item
    • Click on the Invite to Project button and select the integration API Key you just created with Project Read Only permissions
    • Click Invite to Project to confirm
note
  • Repeat this for every project you want to monitor
  • The API key must have both Organization Billing Viewer and Project Read Only permissions
Click to view Secreenshots of the steps

Projects list Projects

Access Manager and Project Invitation Project Access Manager

Permission while Inviting to Project Invite to Project


Step 4: Set Up Integration in nOps

  1. Access the Business Context+ Integrations page to begin.
  2. Select the MongoDB integration card.
  3. Click on the +Add MongoDB Atlas Integration button

Configuration Parameters

  1. Enter Organization ID

  2. Configure API Keys

    • Enter the Public and Private API Keys
  3. Click Setup to finish

important

Double-check your keys. Incorrect entries will prevent synchronization.

Click to view Secreenshots of the steps

Business Context Integrations page

Business Context Integrations

MongoDB Atlas Integration

MongoDB Atlas Integration

Configuration Parameters

Configuration Parameters


Troubleshooting

  1. API Key Issues

    • Check for correct roles: Billing Viewer + Project Read Only
    • Ensure keys are active and entered correctly
  2. Project Access Problems

    • Confirm the API key has access to each project
    • Verify permissions were added properly
  3. Data Not Appearing

    • Allow up to 24 hours after setup
    • Check Organization ID, API keys, and permissions
  4. Multiple Organizations

    • Use distinct API keys per organization
    • Repeat project access configuration for each
    • Verify correct Organization ID is used for each setup

For support, contact nOps with your Organization ID and error messages.